home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #5 / Amiga Plus CD - 2000 - No. 5.iso / Tools / Dev / lame_src / USAGE < prev    next >
Text File  |  2000-01-01  |  22KB  |  662 lines
  1.  
  2. % lame [options] inputfile [outputfile]
  3.  
  4. =======================================================================
  5. Examples:
  6. =======================================================================
  7. fixed bit rate jstereo 128kbs encoding:
  8. % lame sample.wav  sample.mp3      
  9.  
  10. fixed bit rate jstereo 128kbs encoding, highest quality:  (recommended)
  11. % lame -h sample.wav  sample.mp3      
  12.  
  13. To disable joint stereo encoding (slightly faster, but less quality at bitrates<=128kbs)
  14. % lame -m s sample.wav  sample.mp3     
  15.  
  16. Fast encode, low quality  (no psycho-acoustics)
  17. % lame -f sample.wav  sample.mp3     
  18.  
  19. Variable Bitrate (VBR): (use -V n to adjust quality/filesize)
  20. % lame -h -v sample.wav sample.mp3
  21.  
  22. Note: VBR is currently under heavy development.  Right now it can
  23. often result in too much compression.  I would recommend using VBR
  24. with a minimum bitrate of 112kbs.  This will let LAME increase
  25. the bitrate for difficult-to-encode frames, but prevent LAME from
  26. being too aggressive for simple frames:
  27.  
  28. % lame -h -v -b 112  sample.wav sample.mp3
  29.  
  30.  
  31. =======================================================================
  32. LOW BITRATES
  33. =======================================================================
  34. At lower bitrates, (like 24kbs per channel), it is recommended that
  35. you use a 16kHz sampling rate combined with lowpass filtering.  LAME,
  36. as well as commercial encoders (FhG, Xing) will do this automatically.
  37. However, if you feel there is too much (or not enough) lowpass
  38. filtering, you may need to try different values of the lowpass cutoff
  39. and passband width (--resample, --lowpass and --lowpass-width options).
  40.  
  41.  
  42. =======================================================================
  43. STREAMING EXAMPLES
  44. =======================================================================
  45.  
  46. % cat inputfile | lame [options] - - > output
  47.  
  48.  
  49.  
  50.  
  51. =======================================================================
  52.  
  53. For more options, just type:
  54. % lame --help
  55.  
  56. Scripts are included to run lame on multiple files:
  57.  
  58. bach script:  mlame     Run "mlame -h" for instructions.
  59. sh script:    auenc     Run auenc for instructions
  60.  
  61.  
  62.  
  63. =======================================================================
  64. options guide:
  65. =======================================================================
  66. These options are explained in detail below.
  67.  
  68.  
  69. Quality related:
  70.  
  71. -m m/s/j/f     mode selection
  72. -k             disable all filtering
  73. -d             allow block types to differ between channels
  74. --athonly      ignore psy-model output, only use masking from the ATH
  75. --voice        experimental voice encoding mode
  76. --noshort      disable short blocks
  77.  
  78.  
  79. Constant Bit Rate (CBR)
  80. -b  n          set bitrate (8,16,24,...,320)
  81. -h             higher quality but slower
  82. -f             disable noise shaping.  Encodes faster, but lower quality
  83. --freeformat   produce a free format bitstream.  User must also specify
  84.                a bitrate with -b, between 8 and 320 kbs.
  85.  
  86. Variable Bit Rate (VBR)
  87. -v             VBR
  88. --vbr-old      use old variable bitrate (VBR) routine
  89. -V n           VBR quality setting  (0=highest quality, 9=lowest)
  90. -b  n          specify a minimum allowed bitrate (8,16,24,...,320)
  91. -B  n          specify a maximum allowed bitrate (8,16,24,...,320)
  92. -F             strictly enforce minimum bitrate
  93. -t             disable Xing VBR informational tag 
  94. --nohist       disable display of VBR bitrate histogram
  95.  
  96. --abr n        specify average bitrate desired
  97.  
  98.  
  99. Experimental (undocumented):  may work better or worse:
  100.  
  101. -X n           try different quality measures (when comparing quantizations)
  102. -Y             
  103. -Z             
  104.  
  105.  
  106. Operational:
  107.  
  108. -r             assume input file is raw PCM
  109. --decode       assume input file is an mp3 file, and decode to raw pcm.  
  110. -s  n          input sampling frequency in kHz (for raw PCM input files)
  111. --resample n   output sampling frequency
  112. --mp3input     input file is an MP3 file.  decode using mpglib/mpg123
  113. --ogginput     input file is an Ogg Vorbis file.  decode using libvorbis
  114. -x             swap bytes of input file
  115. -a             downmix stereo input file to mono .mp3
  116. -e  n/5/c      de-emphasis
  117. -p             add CRC error protection
  118. -c             mark the encoded file as copyrighted
  119. -o             mark the encoded file as a copy
  120. -S             don't print progress report, VBR histogram
  121. -g             run MP3x, the graphical frame analyzer
  122. --strictly-enforce-ISO   comply as much as possible to ISO MPEG spec
  123.  
  124. --ogg          Encode using Ogg Vorbis (.ogg) instead of mp3.
  125.  
  126. id3 tagging:
  127.  
  128. --tt "title"     title of song (max 30 chars)
  129. --ta "artist"    artist who did the song (max 30 chars)
  130. --tl "album"     album where it came from (max 30 chars)
  131. --ty "year"      year in which the song/album was made (max 4 chars)
  132. --tc "comment"   additional info (max 30 chars)
  133. --tg "genre"     genre of song (name or number)
  134.  
  135.  
  136.  
  137. options not yet described:
  138. --nores            disable bit reservoir
  139. --noath            disable ATH
  140. --cwlimit <freq>   specify range of tonality calculation
  141.  
  142. --lowpass
  143. --lowpass-width
  144. --highpass
  145. --highpass-width
  146.  
  147.  
  148.  
  149.  
  150.  
  151. =======================================================================
  152. Detailed description of all options in alphabetical order
  153. =======================================================================
  154.  
  155.  
  156. =======================================================================
  157. downmix
  158. =======================================================================
  159. -a  
  160.  
  161. mix the stereo input file to mono and encode as mono.  
  162.  
  163. This option is only needed in the case of raw PCM stereo input 
  164. (because LAME cannot determine the number of channels in the input file).
  165. To encode a stereo PCM input file as mono, use "lame -m s -a"
  166.  
  167. For WAV and AIFF input files, using "-m m" will always produce a
  168. mono .mp3 file from both mono and stereo input.
  169.  
  170.  
  171. =======================================================================
  172. average bitrate encoding (aka Safe VBR)
  173. =======================================================================
  174. --abr n
  175.  
  176. turns on encoding with a targeted average bitrate of n kbits, allowing
  177. to use frames of different sizes.  The allowed range of n is 4-310,
  178. you can use any integer value within that range.
  179.  
  180. It can be combined with the -b and -B switches like
  181. lame --abr 123 -b 64 -B 192 a.wav a.mp3
  182. which would limit the allowed frame sizes between 64 and 192 kbits.
  183.  
  184. Using -B is NOT RECOMMENDED.  A 128kbs CBR bitstream, because of the
  185. bit reservoir, can actually have frames which use as many bits as a
  186. 320kbs frame.  VBR modes minimize the use of the bit reservoir, and
  187. thus need to allow 320kbs frames to get the same flexability as CBR
  188. streams.
  189.  
  190.  
  191.  
  192.  
  193. =======================================================================
  194. ATH only
  195. =======================================================================
  196. --athonly
  197.  
  198. This option causes LAME to ignore the output of the psy-model and
  199. only use masking from the ATH.  Might be useful at very high bitrates
  200. or for testing the ATH.  
  201.  
  202.  
  203.  
  204.  
  205. =======================================================================
  206. bitrate
  207. =======================================================================
  208. -b  n
  209.  
  210. For MPEG1 (sampling frequencies of 32, 44.1 and 48kHz)
  211. n =   32,40,48,56,64,80,96,112,128,160,192,224,256,320
  212.  
  213. For MPEG2 (sampling frequencies of 16, 22.05 and 24kHz)
  214. n = 8,16,24,32,40,48,56,64,80,96,112,128,144,160
  215.  
  216.  
  217. The bitrate to be used.  Default is 128kbs MPEG1, 80kbs MPEG2.
  218.  
  219. When used with variable bitrate encodings (VBR), -b specifies the
  220. minimum bitrate to use.  This is useful to prevent LAME VBR from
  221. using some very aggressive compression which can cause some distortion
  222. due to small flaws in the psycho-acoustic model.
  223.  
  224. =======================================================================
  225. max bitrate
  226. =======================================================================
  227. -B  n
  228.  
  229. For MPEG1 (sampling frequencies of 32, 44.1 and 48kHz)
  230. n =   32,40,48,56,64,80,96,112,128,160,192,224,256,320
  231.  
  232. For MPEG2 (sampling frequencies of 16, 22.05 and 24kHz)
  233. n = 8,16,24,32,40,48,56,64,80,96,112,128,144,160
  234.  
  235. Maximum allowed bitrate when using VBR.
  236.  
  237.  
  238. =======================================================================
  239. copyright
  240. =======================================================================
  241. -c   
  242.  
  243. mark the encoded file as copyrighted
  244.  
  245.  
  246.  
  247. =======================================================================
  248. block type control
  249. =======================================================================
  250. -d 
  251.  
  252. Allows the left and right channels to use different block types.
  253. Normally this is not allowed, only because the FhG encoder does
  254. not seem to allow it either.  If anyone finds a sample where -d
  255. produces better results, let me know.  (mt@sulaco.org)
  256.  
  257.  
  258. =======================================================================
  259. mpglib decode capability
  260. =======================================================================
  261. --decode 
  262.  
  263. This just uses LAME's mpg123/mpglib interface to decode an MP3 file to
  264. a raw pcm file.  The input file must be an MP3 file, and the raw pcm
  265. data will be written to the output file in native endian format.
  266. Under linux, on i386, to convert the output file to a wav, use:
  267.  
  268. % lame --decode input.mp3 output.pcm
  269. % sox -c 2 -t raw -r 44100 -s -w output.pcm output.wav
  270.  
  271. (assuming output.pcm came from a stereo, 44.1khz mp3 file)
  272.  
  273.  
  274.  
  275. =======================================================================
  276. de-emphasis
  277. =======================================================================
  278. -e  n/5/c   
  279.  
  280.   n = (none, default)
  281.   5 = 0/15 microseconds
  282.   c = citt j.17
  283.  
  284. All this does is set a flag in the bitstream.  If you have a PCM
  285. input file where one of the above types of (obsolete) emphasis has
  286. been applied, you can set this flag in LAME.  Then the mp3 decoder
  287. should de-emphasize the output during playback, although most 
  288. decoders ignore this flag.
  289.  
  290. A better solution would be to apply the de-emphasis with a standalone
  291. utility before encoding, and then encode without -e.  
  292.  
  293.  
  294.  
  295. =======================================================================
  296. fast mode
  297. =======================================================================
  298. -f   
  299.  
  300. disable noise shaping.  Encodes faster, but lower quality.
  301. Psycho acoustics are computed for bit allocation and 
  302. pre-echo detection.
  303.  
  304. =======================================================================
  305. strictly enforce VBR minimum bitrate
  306. =======================================================================
  307. -F   
  308.  
  309. strictly enforce VBR minimum bitrate.  With out this optioni, the minimum
  310. bitrate will be ignored for passages of analog silence.
  311.  
  312.  
  313.  
  314. =======================================================================
  315. free format bitstreams
  316. =======================================================================
  317. --freeformat   
  318.  
  319. LAME will produce a fixed bitrate, free format bitstream.
  320. User must specify the desired bitrate in kbs, which can
  321. be any integer between 8 and 320.
  322.  
  323. Not supported by most decoders.  Decoders only required to support
  324. up to 320kbs.  
  325.  
  326. Decoders which can handle free format:
  327.                      supports up to
  328. "lame --decode"          560kbs  
  329. Freeamp:                 440kbs
  330. l3dec:                   310kbs
  331.  
  332.  
  333.  
  334.  
  335.  
  336. =======================================================================
  337. graphical frame analyzer
  338. =======================================================================
  339. -g
  340.  
  341. run MP3x, the graphical frame analyzer analysis on the inputfile.  The
  342. inputfile can be either an .mp3 file or uncompressed audio file.  MP3x
  343. support must be compiled into LAME, and requires GTK 1.2.
  344. Documentation is under the About pull down menu.
  345.  
  346.  
  347.  
  348. =======================================================================
  349. high quality
  350. =======================================================================
  351. -h
  352.  
  353. use (maybe) some quality improvements
  354.  
  355. LAME 3.21 and up:  -h enables specialized mid/side masking thresholds to
  356. be used in jstereo mode.  Will sound better in jstereo mode
  357. but is 20% slower.  No effect for mono files.
  358.  
  359. LAME 3.58beta and up: -h also enables a more accurate but slightly
  360. slower quantization formula.  
  361.  
  362.  
  363.  
  364. =======================================================================
  365. sfb=21 cutoff
  366. =======================================================================
  367. -k   
  368.  
  369. keep all frequencies.  (Disable all filters)
  370.  
  371. Without -k, LAME will automatically apply various types of lowpass
  372. filters.  This is because the high frequency coefficients can take up
  373. a lot of bits that would be better used for lower, more important
  374. frequencies.
  375.  
  376.  
  377.  
  378.  
  379. =======================================================================
  380. Modes:
  381. =======================================================================
  382.  
  383. -m m           mono.  
  384. -m s           stereo
  385. -m j           jstereo
  386. -m f           forced mid/side stereo
  387.  
  388. mono is the default mode for mono input files.  If "-m m" is specified
  389. for a stereo input file, the two channels will be averaged into a mono
  390. signal.  
  391.  
  392. jstereo is the default mode for stereo files with fixed bitrates of
  393. 128kbs or less.  At higher fixed bitrates, the default is stereo.
  394. For VBR encoding, jstereo is the default for VBR_q >4, and stereo
  395. is the default for VBR_q <=4.  You can override all of these defaults
  396. by specifing the mode on the command line.  
  397.  
  398. jstereo means the encoder can use (on a frame by frame bases) either
  399. regular stereo (just encode left and right channels independently)
  400. or mid/side stereo.  In mid/side stereo, the mid (L+R) and side (L-R)
  401. channels are encoded, and more bits are allocated to the mid channel
  402. than the side channel.  This will effectively increase the bandwidth
  403. if the signal does not have too much stereo separation.  
  404.  
  405. Mid/side stereo is basically a trick to increase bandwidth.  At 128kbs,
  406. it is clearly worth while.  At higher bitrates it is less usefull.  
  407.  
  408. Using mid/side stereo inappropriately can result in audible
  409. compression artifacts.  To much switching between mid/side and regular
  410. stereo can also sound bad.  To determine when to switch to mid/side
  411. stereo, LAME uses a much more sophisticated algorithm than that
  412. described in the ISO documentation.
  413.  
  414. -m f forces all frames to be encoded mid/side stereo.  It 
  415. should only be used if you are sure every frame of the input file
  416. has very little stereo seperation.  
  417.  
  418.  
  419.  
  420. =======================================================================
  421. MP3 input file
  422. =======================================================================
  423. --mp3input
  424.  
  425. Assume the input file is a MP3 file.  Usefull for downsampling from
  426. one mp3 to another.  If the filename ends in ".mp3" LAME will assume
  427. it is an MP3.  For stdin or MP3 files which dont end in .mp3 you need
  428. to use this switch.
  429.  
  430.  
  431. =======================================================================
  432. disable historgram display
  433. =======================================================================
  434. --nohist
  435.  
  436. By default, LAME will display a bitrate histogram while producing
  437. VBR mp3 files.  This will disable that feature.
  438.  
  439.  
  440. =======================================================================
  441. disable short blocks
  442. =======================================================================
  443. --noshort
  444.  
  445. Encode all frames using long blocks.
  446.  
  447.  
  448.  
  449. =======================================================================
  450. non-original
  451. =======================================================================
  452. -o   
  453.  
  454. mark the encoded file as a copy
  455.  
  456.  
  457.  
  458. =======================================================================
  459. Ogg Vorbis encoding
  460. =======================================================================
  461. --ogg
  462.  
  463. Encode using the Ogg Vobis codec (using libvorbis) instead of
  464. LAME's internal mp3 codec.
  465.  
  466. Assume the input file is an Ogg Vorbis file.  Mostly usefull
  467. with --decode for playing back .ogg files.  
  468. If the filename ends in ".ogg" LAME will assume
  469. it is an Ogg.  For stdin or files which dont end in .ogg you need
  470. to use this switch.
  471.  
  472.  
  473. =======================================================================
  474. Ogg Vorbis input file
  475. =======================================================================
  476. --ogginput
  477.  
  478. Assume the input file is an Ogg Vorbis file.  Mostly usefull
  479. with --decode for playing back .ogg files, or converting
  480. your .ogg collection to MP3 :-)
  481.  
  482. If the filename ends in ".ogg" LAME will assume it is Ogg.  For
  483. stdin or files which dont end in .ogg you need to use this switch.
  484.  
  485.  
  486.  
  487.  
  488. =======================================================================
  489. CRC error protection
  490. =======================================================================
  491. -p  
  492.  
  493. turn on CRC error protection.  
  494. Yes this really does work correctly in LAME.  However, it takes 
  495. 16 bits per frame that would otherwise be used for encoding.
  496.  
  497.  
  498.  
  499. =======================================================================
  500. input file is raw pcm
  501. =======================================================================
  502. -r  
  503.  
  504. Assume the input file is raw pcm.  Sampling rate and mono/stereo/jstereo
  505. must be specified on the command line.  Without -r, LAME will perform
  506. several fseek()'s on the input file looking for WAV and AIFF headers.
  507.  
  508. Not supported if LAME is compiled to use LIBSNDFILE.
  509.  
  510.  
  511.  
  512. =======================================================================
  513. output sampling frequency in kHZ
  514. =======================================================================
  515. --resample  n
  516.  
  517. where n = 16, 22.05, 24, 32, 44.1, 48
  518.  
  519. Output sampling frequency.  Resample the input if necessary.  
  520.  
  521. If not specified, LAME may sometimes resample automatically 
  522. when faced with extreme compression conditions (like encoding
  523. a 44.1khz input file at 16kbs).  
  524.  
  525.  
  526.  
  527. =======================================================================
  528. sampling frequency in kHZ
  529. =======================================================================
  530. -s  n
  531.  
  532. where n = sampling rate in kHz.
  533.  
  534. Required for raw PCM input files.  Otherwise it will be determined
  535. from the header information in the input file.
  536.  
  537. LAME will automatically resample the input file to one of the
  538. supported MP3 samplerates if necessary.
  539.  
  540.  
  541. =======================================================================
  542. silent operation
  543. =======================================================================
  544. -S
  545.  
  546. don't print progress report
  547.  
  548.  
  549. =======================================================================
  550. strict ISO complience
  551. =======================================================================
  552. --strictly-enforce-ISO   
  553.  
  554. With this option, LAME will enforce the 7680 bit limitation on
  555. total frame size.  This results in many wasted bits for
  556. high bitrate encodings.
  557.  
  558.  
  559. =======================================================================
  560. disable Xing VBR tag
  561. =======================================================================
  562. -t              
  563.  
  564. Disable writing of the Xing VBR Tag (only valid if -v flag is
  565. specified) This tag in embedded in frame 0 of the MP3 file.  It lets
  566. VBR aware players correctly seek and compute playing times of VBR
  567. files.
  568.  
  569.  
  570.  
  571. =======================================================================
  572. variable bit rate  (VBR)
  573. =======================================================================
  574. -v
  575.  
  576. Turn on VBR.  There are several ways you can use VBR.  I personally
  577. like using VBR to get files slightly bigger than 128kbs files, where
  578. the extra bits are used for the occasional difficult-to-encode frame.
  579. For this, try specifying a minimum bitrate to use with VBR:
  580.  
  581. lame -v -b 112  input.wav output.mp3
  582.  
  583. If the file is too big, use -V n, where n=0..9
  584.  
  585. lame -v -V n   -b 112  input.wav output.mp3
  586.  
  587.  
  588. If you wan to use VBR to get the maximum compression possible,
  589. and for this, you can try:  
  590.  
  591. lame -v  input.wav output.mp3
  592. lame -v -V n input.wav output.mp3         (to very quality/filesize)
  593.  
  594.  
  595.  
  596.  
  597. =======================================================================
  598. old variable bit rate  (VBR)
  599. =======================================================================
  600. --vbr-old
  601.  
  602. same as -v but turns on the old VBR routine
  603.  
  604.  
  605.  
  606. =======================================================================
  607. VBR quality setting
  608. =======================================================================
  609. -V n       
  610.  
  611. n=0..9.  Specifies the value of VBR_q.  default=4.  0=highest quality.
  612.  
  613.  
  614.  
  615. How is VBR_q used?
  616.  
  617. OVER = number of scalefactor bands with distortion that exceeds the
  618. allowed distortion given by the masking thresholds.  OVER is computed
  619. by outer_loop, and the masking thresholds are computed by the
  620. psycho-acoustic model. 
  621.  
  622. VBR_q = the minimum value of OVER which is to be allowed.
  623. LAME will choose the smallest bitrate for which OVER <= VBR_q.  
  624. (a minimum allowed bitrate can be set with -b.  default=64kbs)
  625.  
  626. If the frame contains short blocks, then the minimum bitrate is made
  627. much larger since the OVER does not adequately measure distortion
  628. caused by pre-echo.  LAME uses bitrates of at least 160kbs for short
  629. blocks to make sure they sound good.
  630.  
  631. *NOTE* No psy-model is perfect, so there can often be distortion which
  632. is audible even though the psy-model claims it is not!  Thus using a
  633. small minimum bitrate can result in some aggressive compression and
  634. audible distortion even with -V 0.  Thus using -V 0 does not sound
  635. better than a fixed 256kbs encoding.  For example: suppose in the 1kHz
  636. frequency band the psy-model claims 20db of distortion will not be
  637. detectable by the human ear, so LAME VBR-0 will compress that
  638. frequency band as much as possible and introduce at most 20db of
  639. distortion.  Using a fixed 256kbit framesize, LAME could end up
  640. introducing only 2db of distortion.  If the psy-model was correct,
  641. they will both sound the same.  If the psy-model was wrong, the VBR-0
  642. result can sound worse.
  643.  
  644.  
  645. =======================================================================
  646. voice encoding mode
  647. =======================================================================
  648. --voice
  649.  
  650. An experimental voice encoding mode.  Tuned for 44.1kHz input files.
  651.  
  652.  
  653. =======================================================================
  654. swapbytes   
  655. =======================================================================
  656. -x
  657.  
  658. swap bytes in the input file.  for sorting out little endian/big endian
  659. type problems.  If your encodings sound like static, try this first.
  660.  
  661.  
  662.